home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / utils / whati~gz.zoo / whatis.5z / whatis
Text File  |  1992-09-13  |  1KB  |  61 lines
  1.  
  2. NAME
  3.     whatis - format of whatis(1) database
  4.  
  5. DESCRIPTION
  6.     These files are used by whatis(1), apropos(1), and whatisin(1).
  7.  
  8.     The  databases are kept in separate file for each section of the
  9.     manual, i.e.,
  10.     
  11.         whatis._0_
  12.         whatis._1_
  13.         whatis._2_
  14.         etc.
  15.     
  16.         whatis._l_
  17.         whatis._n_
  18.         whatis._o_
  19.  
  20.     Each line is either a comment or data.  Comments are blank lines
  21.     or those whose first character is a `#'.
  22.  
  23.     The format for each data line of the databases is:
  24.     
  25.         name%aliases%section%subsection%description%xrefs%keywords
  26.     
  27.  
  28.     name        program/routine/etc name.  (required)
  29.  
  30.     alias        if this sources another manpage  or  is  refered
  31.             by  another name.    a   comma-separated   list.
  32.             (optional)
  33.  
  34.     section        manual section number [0-9nlo].  (required)
  35.  
  36.     subsection    single capital letter.  (optional)
  37.  
  38.     description    what this is, ascii string.  (required)
  39.  
  40.     xref        basically  "SEE ALSO".  a  comma-separated  list.
  41.             (optional)
  42.  
  43.     keywords    any descriptive  keywords. comma-separated list.
  44.             (optional)
  45.  
  46.     Optional or unspecified fields contain only a `_' char.
  47.  
  48.     Here is an example:
  49.     
  50.         unixmode%_%5%_%Extended Filename Standard%sh(1)%MiNT,file
  51.  
  52. SEE ALSO
  53.     whatis(1), apropos(1), whatisin(1), mkwhatis(8)
  54.  
  55. AUTHOR
  56.     Bill Rosenkranz
  57.     rosenkra@convex.com
  58.  
  59. VERSION
  60.     whatis.5 v2.0.1 92/9/12 rosenkra
  61.